/*
 * Copyright 2012-2022 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.boot.web.reactive.context;

import java.util.Arrays;
import java.util.LinkedHashSet;
import java.util.Set;

import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
import org.springframework.beans.factory.support.BeanNameGenerator;
import org.springframework.beans.factory.support.DefaultListableBeanFactory;
import org.springframework.boot.ApplicationContextFactory;
import org.springframework.boot.WebApplicationType;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.context.annotation.AnnotatedBeanDefinitionReader;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.AnnotationConfigRegistry;
import org.springframework.context.annotation.AnnotationConfigUtils;
import org.springframework.context.annotation.AnnotationScopeMetadataResolver;
import org.springframework.context.annotation.ClassPathBeanDefinitionScanner;
import org.springframework.context.annotation.ScopeMetadataResolver;
import org.springframework.core.env.ConfigurableEnvironment;
import org.springframework.stereotype.Component;
import org.springframework.util.Assert;
import org.springframework.util.ClassUtils;
import org.springframework.util.ObjectUtils;

/**
 * {@link ReactiveWebServerApplicationContext}，接受注解类作为输入——
 * 特别是 {@link org.springframework.context.annotation.Configuration @Configuration} 注解的类，
 * 也包括普通的 {@link Component @Component} 类和使用 {@code javax.inject} 注解的符合 JSR-330 规范的类。
 * 支持逐个注册类（将类名指定为配置位置），也支持类路径扫描（将基础包指定为配置位置）。
 * <p>
 * 注意：如果有多个 {@code @Configuration} 类，后加载文件中的 {@code @Bean} 定义
 * 会覆盖先加载文件中的同名定义。这可以用于通过额外的配置类刻意覆盖某些 bean 定义。
 *
 * @author Phillip Webb
 * @since 2.0.0
 * @see #register(Class...)
 * @see #scan(String...)
 * @see ReactiveWebServerApplicationContext
 * @see AnnotationConfigApplicationContext
 */
public class AnnotationConfigReactiveWebServerApplicationContext extends ReactiveWebServerApplicationContext
		implements AnnotationConfigRegistry {

	private final AnnotatedBeanDefinitionReader reader;

	private final ClassPathBeanDefinitionScanner scanner;

	private final Set<Class<?>> annotatedClasses = new LinkedHashSet<>();

	private String[] basePackages;

	/**
	 * 创建一个新的 {@link AnnotationConfigReactiveWebServerApplicationContext}，
	 * 需要通过 {@link #register} 调用进行填充，然后手动调用 {@linkplain #refresh} 刷新上下文。
	 */
	public AnnotationConfigReactiveWebServerApplicationContext() {
		this.reader = new AnnotatedBeanDefinitionReader(this);
		this.scanner = new ClassPathBeanDefinitionScanner(this);
	}

	/**
	 * 使用给定的 {@code DefaultListableBeanFactory} 创建一个新的 {@link AnnotationConfigReactiveWebServerApplicationContext}。
	 * 该上下文需要通过 {@link #register} 调用进行填充，然后手动调用 {@linkplain #refresh} 刷新上下文。
	 * @param beanFactory 用于此上下文的 DefaultListableBeanFactory 实例
	 */
	public AnnotationConfigReactiveWebServerApplicationContext(DefaultListableBeanFactory beanFactory) {
		super(beanFactory);
		this.reader = new AnnotatedBeanDefinitionReader(this);
		this.scanner = new ClassPathBeanDefinitionScanner(this);
	}

	/**
	 * 创建一个新的 {@link AnnotationConfigReactiveWebServerApplicationContext}，
	 * 从给定的注解类派生 Bean 定义并自动刷新上下文。
	 * @param annotatedClasses 一个或多个注解类，例如 {@code @Configuration} 类
	 */
	public AnnotationConfigReactiveWebServerApplicationContext(Class<?>... annotatedClasses) {
		this();
		register(annotatedClasses);
		refresh();
	}

	/**
	 * 创建一个新的 {@link AnnotationConfigReactiveWebServerApplicationContext}，
	 * 在给定的包中扫描 Bean 定义并自动刷新上下文。
	 * @param basePackages 要检查注解类的包
	 */
	public AnnotationConfigReactiveWebServerApplicationContext(String... basePackages) {
		this();
		scan(basePackages);
		refresh();
	}

	/**
	 * {@inheritDoc}
	 * <p>
	 * 将给定的环境委托给底层的 {@link AnnotatedBeanDefinitionReader} 和
	 * {@link ClassPathBeanDefinitionScanner} 成员。
	 */
	@Override
	public void setEnvironment(ConfigurableEnvironment environment) {
		super.setEnvironment(environment);
		this.reader.setEnvironment(environment);
		this.scanner.setEnvironment(environment);
	}

	/**
	 * 为 {@link AnnotatedBeanDefinitionReader} 和/或
	 * {@link ClassPathBeanDefinitionScanner} 提供自定义的 {@link BeanNameGenerator}（如果有）。
	 * <p>
	 * 默认是 {@link org.springframework.context.annotation.AnnotationBeanNameGenerator}。
	 * <p>
	 * 调用此方法必须发生在调用 {@link #register(Class...)} 和/或 {@link #scan(String...)} 之前。
	 * @param beanNameGenerator Bean 名称生成器
	 * @see AnnotatedBeanDefinitionReader#setBeanNameGenerator
	 * @see ClassPathBeanDefinitionScanner#setBeanNameGenerator
	 */
	public void setBeanNameGenerator(BeanNameGenerator beanNameGenerator) {
		this.reader.setBeanNameGenerator(beanNameGenerator);
		this.scanner.setBeanNameGenerator(beanNameGenerator);
		getBeanFactory().registerSingleton(AnnotationConfigUtils.CONFIGURATION_BEAN_NAME_GENERATOR, beanNameGenerator);
	}

	/**
	 * 设置用于检测到的 Bean 类的 {@link ScopeMetadataResolver}。
	 * <p>
	 * 默认是 {@link AnnotationScopeMetadataResolver}。
	 * <p>
	 * 调用此方法必须发生在调用 {@link #register(Class...)} 和/或 {@link #scan(String...)} 之前。
	 * @param scopeMetadataResolver 范围元数据解析器
	 */
	public void setScopeMetadataResolver(ScopeMetadataResolver scopeMetadataResolver) {
		this.reader.setScopeMetadataResolver(scopeMetadataResolver);
		this.scanner.setScopeMetadataResolver(scopeMetadataResolver);
	}

	/**
	 * 注册一个或多个待处理的注解类。注意，必须调用 {@link #refresh()}，
	 * 上下文才能完全处理新的类。
	 * <p>
	 * {@code #register} 方法调用是幂等的；多次添加相同的注解类不会有额外效果。
	 * @param annotatedClasses 一个或多个注解类，例如 {@code @Configuration} 类
	 * @see #scan(String...)
	 * @see #refresh()
	 */
	@Override
	public final void register(Class<?>... annotatedClasses) {
		Assert.notEmpty(annotatedClasses, "At least one annotated class must be specified");
		this.annotatedClasses.addAll(Arrays.asList(annotatedClasses));
	}

	/**
	 * 在指定的基础包中执行扫描。注意，必须调用 {@link #refresh()}，
	 * 上下文才能完全处理新的类。
	 * @param basePackages 要扫描注解类的包
	 * @see #register(Class...)
	 * @see #refresh()
	 */
	@Override
	public final void scan(String... basePackages) {
		Assert.notEmpty(basePackages, "At least one base package must be specified");
		this.basePackages = basePackages;
	}

	@Override
	protected void prepareRefresh() {
		this.scanner.clearCache();
		super.prepareRefresh();
	}

	@Override
	protected void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) {
		super.postProcessBeanFactory(beanFactory);
		if (!ObjectUtils.isEmpty(this.basePackages)) {
			this.scanner.scan(this.basePackages);
		}
		if (!this.annotatedClasses.isEmpty()) {
			this.reader.register(ClassUtils.toClassArray(this.annotatedClasses));
		}
	}

	/**
	 * 在 {@code spring.factories} 中注册的 {@link ApplicationContextFactory}，
	 * 用于支持 {@link AnnotationConfigReactiveWebServerApplicationContext}。
	 */
	static class Factory implements ApplicationContextFactory {

		@Override
		public ConfigurableApplicationContext create(WebApplicationType webApplicationType) {
			return (webApplicationType != WebApplicationType.REACTIVE) ? null
					: new AnnotationConfigReactiveWebServerApplicationContext();
		}

	}

}
